Merge pull request containers#8034 from rhatdan/options

Switch help messages from using [flags] to [options]

cmd/podman/auto-update.go

@@ -20,7 +20,7 @@ var (
   or similar units that create new containers in order to run the updated images.
   Note that this command is experimental. Please refer to the podman-auto-update(1) man page for details.`
 	autoUpdateCommand = &cobra.Command{
-		Use:   "auto-update [flags]",
+		Use:   "auto-update [options]",
 		Short: "Auto update containers according to their auto-update policy",
 		Long:  autoUpdateDescription,
 		RunE:  autoUpdate,

cmd/podman/containers/attach.go

@@ -14,7 +14,7 @@ import (
 var (
 	attachDescription = "The podman attach command allows you to attach to a running container using the container's ID or name, either to view its ongoing output or to control it interactively."
 	attachCommand     = &cobra.Command{
-		Use:   "attach [flags] CONTAINER",
+		Use:   "attach [options] CONTAINER",
 		Short: "Attach to a running container",
 		Long:  attachDescription,
 		RunE:  attach,

cmd/podman/containers/checkpoint.go

@@ -20,7 +20,7 @@ var (
    Checkpoints one or more running containers. The container name or ID can be used.
 `
 	checkpointCommand = &cobra.Command{
-		Use:   "checkpoint [flags] CONTAINER [CONTAINER...]",
+		Use:   "checkpoint [options] CONTAINER [CONTAINER...]",
 		Short: "Checkpoints one or more containers",
 		Long:  checkpointDescription,
 		RunE:  checkpoint,

cmd/podman/containers/cleanup.go

@@ -19,7 +19,7 @@ var (
    Cleans up mount points and network stacks on one or more containers from the host. The container name or ID can be used. This command is used internally when running containers, but can also be used if container cleanup has failed when a container exits.
 `
 	cleanupCommand = &cobra.Command{
-		Use:   "cleanup [flags] CONTAINER [CONTAINER...]",
+		Use:   "cleanup [options] CONTAINER [CONTAINER...]",
 		Short: "Cleanup network and mountpoints of one or more containers",
 		Long:  cleanupDescription,
 		RunE:  cleanup,

cmd/podman/containers/commit.go

@@ -18,7 +18,7 @@ var (
 	commitDescription = `Create an image from a container's changes. Optionally tag the image created, set the author with the --author flag, set the commit message with the --message flag, and make changes to the instructions with the --change flag.`
 
 	commitCommand = &cobra.Command{
-		Use:   "commit [flags] CONTAINER [IMAGE]",
+		Use:   "commit [options] CONTAINER [IMAGE]",
 		Short: "Create new image based on the changed container",
 		Long:  commitDescription,
 		RunE:  commit,

cmd/podman/containers/cp.go

@@ -16,7 +16,7 @@ var (
   You can copy from the container's file system to the local machine or the reverse, from the local filesystem to the container. If "-" is specified for either the SRC_PATH or DEST_PATH, you can also stream a tar archive from STDIN or to STDOUT. The CONTAINER can be a running or stopped container.  The SRC_PATH or DEST_PATH can be a file or directory.
 `
 	cpCommand = &cobra.Command{
-		Use:     "cp [flags] SRC_PATH DEST_PATH",
+		Use:     "cp [options] SRC_PATH DEST_PATH",
 		Short:   "Copy files/folders between a container and the local filesystem",
 		Long:    cpDescription,
 		Args:    cobra.ExactArgs(2),

cmd/podman/containers/create.go

@@ -29,7 +29,7 @@ var (
 
   The container ID is then printed to stdout. You can then start it at any time with the podman start <container_id> command. The container will be created with the initial state 'created'.`
 	createCommand = &cobra.Command{
-		Use:   "create [flags] IMAGE [COMMAND [ARG...]]",
+		Use:   "create [options] IMAGE [COMMAND [ARG...]]",
 		Short: "Create but do not start a container",
 		Long:  createDescription,
 		RunE:  create,

cmd/podman/containers/diff.go

@@ -13,7 +13,7 @@ import (
 var (
 	// podman container _diff_
 	diffCmd = &cobra.Command{
-		Use:   "diff [flags] CONTAINER",
+		Use:   "diff [options] CONTAINER",
 		Args:  validate.IDOrLatestArgs,
 		Short: "Inspect changes to the container's file systems",
 		Long:  `Displays changes to the container filesystem's'.  The container will be compared to its parent layer.`,

cmd/podman/containers/exec.go

@@ -20,7 +20,7 @@ var (
 	execDescription = `Execute the specified command inside a running container.
 `
 	execCommand = &cobra.Command{
-		Use:                   "exec [flags] CONTAINER [COMMAND [ARG...]]",
+		Use:                   "exec [options] CONTAINER [COMMAND [ARG...]]",
 		Short:                 "Run a process in a running container",
 		Long:                  execDescription,
 		RunE:                  exec,

cmd/podman/containers/exists.go

@@ -12,7 +12,7 @@ var (
 	containerExistsDescription = `If the named container exists in local storage, podman container exists exits with 0, otherwise the exit code will be 1.`
 
 	existsCommand = &cobra.Command{
-		Use:   "exists [flags] CONTAINER",
+		Use:   "exists [options] CONTAINER",
 		Short: "Check if a container exists in local storage",
 		Long:  containerExistsDescription,
 		Example: `podman container exists --external containerID

cmd/podman/containers/export.go

@@ -18,7 +18,7 @@ var (
 		" and saves it on the local machine."
 
 	exportCommand = &cobra.Command{
-		Use:   "export [flags] CONTAINER",
+		Use:   "export [options] CONTAINER",
 		Short: "Export container's filesystem contents as a tar archive",
 		Long:  exportDescription,
 		RunE:  export,

cmd/podman/containers/init.go

@@ -15,7 +15,7 @@ var (
 	initDescription = `Initialize one or more containers, creating the OCI spec and mounts for inspection. Container names or IDs can be used.`
 
 	initCommand = &cobra.Command{
-		Use:   "init [flags] CONTAINER [CONTAINER...]",
+		Use:   "init [options] CONTAINER [CONTAINER...]",
 		Short: "Initialize one or more containers",
 		Long:  initDescription,
 		RunE:  initContainer,

cmd/podman/containers/inspect.go

@@ -11,7 +11,7 @@ import (
 var (
 	// podman container _inspect_
 	inspectCmd = &cobra.Command{
-		Use:   "inspect [flags] CONTAINER [CONTAINER...]",
+		Use:   "inspect [options] CONTAINER [CONTAINER...]",
 		Short: "Display the configuration of a container",
 		Long:  `Displays the low-level information on a container identified by name or ID.`,
 		RunE:  inspectExec,

cmd/podman/containers/kill.go

@@ -17,7 +17,7 @@ import (
 var (
 	killDescription = "The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal."
 	killCommand     = &cobra.Command{
-		Use:   "kill [flags] CONTAINER [CONTAINER...]",
+		Use:   "kill [options] CONTAINER [CONTAINER...]",
 		Short: "Kill one or more running containers with a specific signal",
 		Long:  killDescription,
 		RunE:  kill,

cmd/podman/containers/list.go

@@ -10,7 +10,7 @@ import (
 var (
 	// podman container _list_
 	listCmd = &cobra.Command{
-		Use:     "list",
+		Use:     "list [options]",
 		Aliases: []string{"ls"},
 		Args:    validate.NoArgs,
 		Short:   "List containers",

cmd/podman/containers/logs.go

@@ -27,7 +27,7 @@ var (
   This does not guarantee execution order when combined with podman run (i.e., your run may not have generated any logs at the time you execute podman logs).
 `
 	logsCommand = &cobra.Command{
-		Use:   "logs [flags] CONTAINER [CONTAINER...]",
+		Use:   "logs [options] CONTAINER [CONTAINER...]",
 		Short: "Fetch the logs of one or more containers",
 		Long:  logsDescription,
 		Args: func(cmd *cobra.Command, args []string) error {

cmd/podman/containers/mount.go

@@ -25,7 +25,7 @@ var (
 `
 
 	mountCommand = &cobra.Command{
-		Use:   "mount [flags] [CONTAINER...]",
+		Use:   "mount [options] [CONTAINER...]",
 		Short: "Mount a working container's root filesystem",
 		Long:  mountDescription,
 		RunE:  mount,

cmd/podman/containers/pause.go

@@ -17,7 +17,7 @@ import (
 var (
 	pauseDescription = `Pauses one or more running containers.  The container name or ID can be used.`
 	pauseCommand     = &cobra.Command{
-		Use:   "pause [flags] CONTAINER [CONTAINER...]",
+		Use:   "pause [options] CONTAINER [CONTAINER...]",
 		Short: "Pause all the processes in one or more containers",
 		Long:  pauseDescription,
 		RunE:  pause,

cmd/podman/containers/port.go

@@ -18,7 +18,7 @@ var (
 	portDescription = `List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT
 `
 	portCommand = &cobra.Command{
-		Use:   "port [flags] CONTAINER [PORT]",
+		Use:   "port [options] CONTAINER [PORT]",
 		Short: "List port mappings or a specific mapping for the container",
 		Long:  portDescription,
 		RunE:  port,
@@ -31,7 +31,7 @@ var (
 	}
 
 	containerPortCommand = &cobra.Command{
-		Use:   "port [flags] CONTAINER [PORT]",
+		Use:   "port [options] CONTAINER [PORT]",
 		Short: portCommand.Short,
 		Long:  portDescription,
 		RunE:  portCommand.RunE,

cmd/podman/containers/prune.go

@@ -21,7 +21,7 @@ var (
 
 	Removes all non running containers`)
 	pruneCommand = &cobra.Command{
-		Use:     "prune [flags]",
+		Use:     "prune [options]",
 		Short:   "Remove all non running containers",
 		Long:    pruneDescription,
 		RunE:    prune,

cmd/podman/containers/ps.go

@@ -27,7 +27,7 @@ import (
 var (
 	psDescription = "Prints out information about the containers"
 	psCommand     = &cobra.Command{
-		Use:   "ps",
+		Use:   "ps [options]",
 		Args:  validate.NoArgs,
 		Short: "List containers",
 		Long:  psDescription,

cmd/podman/containers/restart.go

@@ -20,7 +20,7 @@ var (
   A timeout before forcibly stopping can be set, but defaults to %d seconds.`, containerConfig.Engine.StopTimeout)
 
 	restartCommand = &cobra.Command{
-		Use:   "restart [flags] CONTAINER [CONTAINER...]",
+		Use:   "restart [options] CONTAINER [CONTAINER...]",
 		Short: "Restart one or more containers",
 		Long:  restartDescription,
 		RunE:  restart,

cmd/podman/containers/restore.go

@@ -20,7 +20,7 @@ var (
    Restores a container from a checkpoint. The container name or ID can be used.
 `
 	restoreCommand = &cobra.Command{
-		Use:   "restore [flags] CONTAINER [CONTAINER...]",
+		Use:   "restore [options] CONTAINER [CONTAINER...]",
 		Short: "Restores one or more containers from a checkpoint",
 		Long:  restoreDescription,
 		RunE:  restore,

cmd/podman/containers/rm.go

@@ -21,7 +21,7 @@ var (
 
   Command does not remove images. Running or unusable containers will not be removed without the -f option.`
 	rmCommand = &cobra.Command{
-		Use:   "rm [flags] CONTAINER [CONTAINER...]",
+		Use:   "rm [options] CONTAINER [CONTAINER...]",
 		Short: "Remove one or more containers",
 		Long:  rmDescription,
 		RunE:  rm,

cmd/podman/containers/run.go

@@ -25,7 +25,7 @@ var (
 	runDescription = "Runs a command in a new container from the given image"
 	runCommand     = &cobra.Command{
 		Args:  cobra.MinimumNArgs(1),
-		Use:   "run [flags] IMAGE [COMMAND [ARG...]]",
+		Use:   "run [options] IMAGE [COMMAND [ARG...]]",
 		Short: "Run a command in a new container",
 		Long:  runDescription,
 		RunE:  run,

cmd/podman/containers/runlabel.go

@@ -24,7 +24,7 @@ var (
 	runlabelOptions     = runlabelOptionsWrapper{}
 	runlabelDescription = "Executes a command as described by a container image label."
 	runlabelCommand     = &cobra.Command{
-		Use:   "runlabel [flags] LABEL IMAGE [ARG...]",
+		Use:   "runlabel [options] LABEL IMAGE [ARG...]",
 		Short: "Execute the command described by an image label",
 		Long:  runlabelDescription,
 		RunE:  runlabel,

cmd/podman/containers/start.go

@@ -17,7 +17,7 @@ import (
 var (
 	startDescription = `Starts one or more containers.  The container name or ID can be used.`
 	startCommand     = &cobra.Command{
-		Use:   "start [flags] CONTAINER [CONTAINER...]",
+		Use:   "start [options] CONTAINER [CONTAINER...]",
 		Short: "Start one or more containers",
 		Long:  startDescription,
 		RunE:  start,

cmd/podman/containers/stats.go

@@ -26,7 +26,7 @@ import (
 var (
 	statsDescription = "Display percentage of CPU, memory, network I/O, block I/O and PIDs for one or more containers."
 	statsCommand     = &cobra.Command{
-		Use:   "stats [flags] [CONTAINER...]",
+		Use:   "stats [options] [CONTAINER...]",
 		Short: "Display a live stream of container resource usage statistics",
 		Long:  statsDescription,
 		RunE:  stats,

cmd/podman/containers/stop.go

@@ -17,7 +17,7 @@ var (
 
   A timeout to forcibly stop the container can also be set but defaults to %d seconds otherwise.`, containerConfig.Engine.StopTimeout)
 	stopCommand = &cobra.Command{
-		Use:   "stop [flags] CONTAINER [CONTAINER...]",
+		Use:   "stop [options] CONTAINER [CONTAINER...]",
 		Short: "Stop one or more containers",
 		Long:  stopDescription,
 		RunE:  stop,

cmd/podman/containers/top.go

@@ -26,7 +26,7 @@ var (
 	topOptions = entities.TopOptions{}
 
 	topCommand = &cobra.Command{
-		Use:   "top [flags] CONTAINER [FORMAT-DESCRIPTORS|ARGS...]",
+		Use:   "top [options] CONTAINER [FORMAT-DESCRIPTORS|ARGS...]",
 		Short: "Display the running processes of a container",
 		Long:  topDescription,
 		RunE:  top,

cmd/podman/containers/unmount.go

@@ -19,7 +19,7 @@ var (
   An unmount can be forced with the --force flag.
 `
 	unmountCommand = &cobra.Command{
-		Use:     "unmount [flags] CONTAINER [CONTAINER...]",
+		Use:     "unmount [options] CONTAINER [CONTAINER...]",
 		Aliases: []string{"umount"},
 		Short:   "Unmounts working container's root filesystem",
 		Long:    description,

cmd/podman/containers/unpause.go

@@ -17,7 +17,7 @@ import (
 var (
 	unpauseDescription = `Unpauses one or more previously paused containers.  The container name or ID can be used.`
 	unpauseCommand     = &cobra.Command{
-		Use:   "unpause [flags] CONTAINER [CONTAINER...]",
+		Use:   "unpause [options] CONTAINER [CONTAINER...]",
 		Short: "Unpause the processes in one or more containers",
 		Long:  unpauseDescription,
 		RunE:  unpause,

cmd/podman/containers/wait.go

@@ -19,7 +19,7 @@ var (
 	waitDescription = `Block until one or more containers stop and then print their exit codes.
 `
 	waitCommand = &cobra.Command{
-		Use:   "wait [flags] CONTAINER [CONTAINER...]",
+		Use:   "wait [options] CONTAINER [CONTAINER...]",
 		Short: "Block on one or more containers",
 		Long:  waitDescription,
 		RunE:  wait,

cmd/podman/diff.go

@@ -17,7 +17,7 @@ var (
 	// Command: podman _diff_ Object_ID
 	diffDescription = `Displays changes on a container or image's filesystem.  The container or image will be compared to its parent layer.`
 	diffCmd         = &cobra.Command{
-		Use:   "diff [flags] {CONTAINER_ID | IMAGE_ID}",
+		Use:   "diff [options] {CONTAINER_ID | IMAGE_ID}",
 		Args:  validate.IDOrLatestArgs,
 		Short: "Display the changes to the object's file system",
 		Long:  diffDescription,

cmd/podman/generate/kube.go

@@ -20,7 +20,7 @@ var (
 Whether the input is for a container or pod, Podman will always generate the specification as a pod.`
 
 	kubeCmd = &cobra.Command{
-		Use:   "kube [flags] CONTAINER | POD",
+		Use:   "kube [options] CONTAINER | POD",
 		Short: "Generate Kubernetes YAML from a container or pod.",
 		Long:  kubeDescription,
 		RunE:  kube,

cmd/podman/generate/systemd.go

@@ -24,7 +24,7 @@ var (
   The generated units can later be controlled via systemctl(1).`
 
 	systemdCmd = &cobra.Command{
-		Use:   "systemd [flags] CTR|POD",
+		Use:   "systemd [options] CTR|POD",
 		Short: "Generate systemd units.",
 		Long:  systemdDescription,
 		RunE:  systemd,

cmd/podman/images/build.go

@@ -40,7 +40,7 @@ var (
 	// Command: podman _diff_ Object_ID
 	buildDescription = "Builds an OCI or Docker image using instructions from one or more Containerfiles and a specified build context directory."
 	buildCmd         = &cobra.Command{
-		Use:   "build [flags] [CONTEXT]",
+		Use:   "build [options] [CONTEXT]",
 		Short: "Build an image using instructions from Containerfiles",
 		Long:  buildDescription,
 		Args:  cobra.MaximumNArgs(1),

cmd/podman/images/diff.go

@@ -13,7 +13,7 @@ import (
 var (
 	// podman container _inspect_
 	diffCmd = &cobra.Command{
-		Use:   "diff [flags] IMAGE",
+		Use:   "diff [options] IMAGE",
 		Args:  cobra.ExactArgs(1),
 		Short: "Inspect changes to the image's file systems",
 		Long:  `Displays changes to the image's filesystem.  The image will be compared to its parent layer.`,

cmd/podman/images/history.go

@@ -27,7 +27,7 @@ var (
 
 	// podman _history_
 	historyCmd = &cobra.Command{
-		Use:     "history [flags] IMAGE",
+		Use:     "history [options] IMAGE",
 		Short:   "Show history of a specified image",
 		Long:    long,
 		Args:    cobra.ExactArgs(1),

cmd/podman/images/import.go

@@ -19,7 +19,7 @@ var (
   Note remote tar balls can be specified, via web address.
   Optionally tag the image. You can specify the instructions using the --change option.`
 	importCommand = &cobra.Command{
-		Use:   "import [flags] PATH [REFERENCE]",
+		Use:   "import [options] PATH [REFERENCE]",
 		Short: "Import a tarball to create a filesystem image",
 		Long:  importDescription,
 		RunE:  importCon,

cmd/podman/images/inspect.go

@@ -10,7 +10,7 @@ import (
 var (
 	// Command: podman image _inspect_
 	inspectCmd = &cobra.Command{
-		Use:   "inspect [flags] IMAGE [IMAGE...]",
+		Use:   "inspect [options] IMAGE [IMAGE...]",
 		Short: "Display the configuration of an image",
 		Long:  `Displays the low-level information of an image identified by name or ID.`,
 		RunE:  inspectExec,

cmd/podman/images/list.go

@@ -35,7 +35,7 @@ type listFlagType struct {
 var (
 	// Command: podman image _list_
 	listCmd = &cobra.Command{
-		Use:     "list [flags] [IMAGE]",
+		Use:     "list [options] [IMAGE]",
 		Aliases: []string{"ls"},
 		Args:    cobra.MaximumNArgs(1),
 		Short:   "List images in local storage",

cmd/podman/images/load.go

@@ -22,7 +22,7 @@ import (
 var (
 	loadDescription = "Loads an image from a locally stored archive (tar file) into container storage."
 	loadCommand     = &cobra.Command{
-		Use:   "load [flags] [NAME[:TAG]]",
+		Use:   "load [options] [NAME[:TAG]]",
 		Short: "Load an image from container archive",
 		Long:  loadDescription,
 		RunE:  load,