Second chunk of Cobra help

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Adds examples to Cobra help for a second chunk of commands.

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
This commit is contained in:
TomSweeneyRedHat
2019-02-14 17:12:16 -05:00
parent 9c1b08fd79
commit 72b91eb87f
20 changed files with 59 additions and 20 deletions

View File

@ -22,7 +22,9 @@ var (
attachCommand.GlobalFlags = MainGlobalOpts attachCommand.GlobalFlags = MainGlobalOpts
return attachCmd(&attachCommand) return attachCmd(&attachCommand)
}, },
Example: "", Example: `podman attach ctrID
podman attach 1234
podman attach --no-stdin foobar`,
} }
) )

View File

@ -29,7 +29,9 @@ var (
checkpointCommand.GlobalFlags = MainGlobalOpts checkpointCommand.GlobalFlags = MainGlobalOpts
return checkpointCmd(&checkpointCommand) return checkpointCmd(&checkpointCommand)
}, },
Example: "CONTAINER-NAME [CONTAINER-NAME ...]", Example: `podman checkpoint --keep ctrID
podman checkpoint --all
podman checkpoint --leave-running --latest`,
} }
) )

View File

@ -46,7 +46,9 @@ var (
diffCommand.GlobalFlags = MainGlobalOpts diffCommand.GlobalFlags = MainGlobalOpts
return diffCmd(&diffCommand) return diffCmd(&diffCommand)
}, },
Example: "ID-NAME", Example: `podman diff imageID
podman diff ctrID
podman diff --format json redis:alpine`,
} }
) )

View File

@ -29,7 +29,9 @@ var (
execCommand.GlobalFlags = MainGlobalOpts execCommand.GlobalFlags = MainGlobalOpts
return execCmd(&execCommand) return execCmd(&execCommand)
}, },
Example: "CONTAINER-NAME", Example: `podman exec -it ctrID ls
podman exec -it -w /tmp myCtr pwd
podman exec --user root ctrID ls`,
} }
) )

View File

@ -25,7 +25,8 @@ var (
exportCommand.GlobalFlags = MainGlobalOpts exportCommand.GlobalFlags = MainGlobalOpts
return exportCmd(&exportCommand) return exportCmd(&exportCommand)
}, },
Example: "CONTAINER", Example: `podman export ctrID > myCtr.tar
podman export --output="myCtr.tar" ctrID`,
} }
) )

View File

@ -25,7 +25,9 @@ var (
importCommand.GlobalFlags = MainGlobalOpts importCommand.GlobalFlags = MainGlobalOpts
return importCmd(&importCommand) return importCmd(&importCommand)
}, },
Example: "TARBALL [REFERENCE]", Example: `podman import http://example.com/ctr.tar url-image
cat ctr.tar | podman -q import --message "importing the ctr.tar tarball" - image-imported
cat ctr.tar | podman import -`,
} }
) )

View File

@ -28,7 +28,9 @@ var (
killCommand.GlobalFlags = MainGlobalOpts killCommand.GlobalFlags = MainGlobalOpts
return killCmd(&killCommand) return killCmd(&killCommand)
}, },
Example: "CONTAINER-NAME [CONTAINER-NAME ...]", Example: `podman kill mywebserver
podman kill 860a4b23
podman kill --signal TERM ctrID`,
} }
) )

View File

@ -22,7 +22,9 @@ var (
logoutCommand.GlobalFlags = MainGlobalOpts logoutCommand.GlobalFlags = MainGlobalOpts
return logoutCmd(&logoutCommand) return logoutCmd(&logoutCommand)
}, },
Example: "REGISTRY", Example: `podman logout docker.io
podman logout --authfile authdir/myauths.json docker.io
podman logout --all`,
} }
) )

View File

@ -28,7 +28,9 @@ var (
pauseCommand.GlobalFlags = MainGlobalOpts pauseCommand.GlobalFlags = MainGlobalOpts
return pauseCmd(&pauseCommand) return pauseCmd(&pauseCommand)
}, },
Example: "CONTAINER-NAME [CONTAINER-NAME ...]", Example: `podman pause mywebserver
podman pause 860a4b23
podman stop -a`,
} }
) )

View File

@ -26,7 +26,9 @@ var (
podStartCommand.GlobalFlags = MainGlobalOpts podStartCommand.GlobalFlags = MainGlobalOpts
return podStartCmd(&podStartCommand) return podStartCmd(&podStartCommand)
}, },
Example: "POD-NAME [POD-NAME ...]", Example: `podman pod start podID
podman pod start --latest
podman pod start --all`,
} }
) )

View File

@ -32,7 +32,9 @@ var (
podStatsCommand.GlobalFlags = MainGlobalOpts podStatsCommand.GlobalFlags = MainGlobalOpts
return podStatsCmd(&podStatsCommand) return podStatsCmd(&podStatsCommand)
}, },
Example: "[POD_NAME_OR_ID]", Example: `podman stats -a --no-stream
podman stats --no-reset ctrID
podman stats --no-stream --format "table {{.ID}} {{.Name}} {{.MemUsage}}" ctrID`,
} }
) )

View File

@ -33,7 +33,9 @@ the latest pod.
podTopCommand.GlobalFlags = MainGlobalOpts podTopCommand.GlobalFlags = MainGlobalOpts
return podTopCmd(&podTopCommand) return podTopCmd(&podTopCommand)
}, },
Example: "POD-NAME [format descriptors]", Example: `podman top ctrID
podman top --latest
podman top --latest pid seccomp args %C`,
} }
) )

View File

@ -166,7 +166,9 @@ var (
psCommand.GlobalFlags = MainGlobalOpts psCommand.GlobalFlags = MainGlobalOpts
return psCmd(&psCommand) return psCmd(&psCommand)
}, },
Example: "", Example: `podman ps -a
podman ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}"
podman ps --size --sort names`,
} }
) )

View File

@ -32,7 +32,8 @@ var (
signCommand.GlobalFlags = MainGlobalOpts signCommand.GlobalFlags = MainGlobalOpts
return signCmd(&signCommand) return signCmd(&signCommand)
}, },
Example: "IMAGE-NAME [IMAGE-NAME ...]", Example: `podman sign --sign-by mykey imageID
podman sign --sign-by mykey --directory ./mykeydir imageID`,
} }
) )

View File

@ -26,7 +26,7 @@ var (
Use: "set", Use: "set",
Short: "Set default trust policy or a new trust policy for a registry", Short: "Set default trust policy or a new trust policy for a registry",
Long: setTrustDescription, Long: setTrustDescription,
Example: "default | REGISTRY[/REPOSITORY]", Example: "",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
setTrustCommand.InputArgs = args setTrustCommand.InputArgs = args
setTrustCommand.GlobalFlags = MainGlobalOpts setTrustCommand.GlobalFlags = MainGlobalOpts

View File

@ -31,7 +31,9 @@ An unmount can be forced with the --force flag.
umountCommand.GlobalFlags = MainGlobalOpts umountCommand.GlobalFlags = MainGlobalOpts
return umountCmd(&umountCommand) return umountCmd(&umountCommand)
}, },
Example: "CONTAINER-NAME-OR-ID", Example: `podman umount ctrID
podman umount ctrID1 ctrID2 ctrID3
podman umount --all`,
} }
) )

View File

@ -29,7 +29,8 @@ var (
unpauseCommand.GlobalFlags = MainGlobalOpts unpauseCommand.GlobalFlags = MainGlobalOpts
return unpauseCmd(&unpauseCommand) return unpauseCmd(&unpauseCommand)
}, },
Example: "CONTAINER-NAME [CONTAINER-NAME ...]", Example: `podman unpause ctrID
podman unpause --all`,
} }
) )

View File

@ -26,7 +26,9 @@ be created at.`
volumeCreateCommand.GlobalFlags = MainGlobalOpts volumeCreateCommand.GlobalFlags = MainGlobalOpts
return volumeCreateCmd(&volumeCreateCommand) return volumeCreateCmd(&volumeCreateCommand)
}, },
Example: "[VOLUME-NAME]", Example: `podman volume create myvol
podman volume create
podman volume create --label foo=bar myvol`,
} }
) )

View File

@ -24,7 +24,9 @@ from JSON to a Go template.
volumeInspectCommand.GlobalFlags = MainGlobalOpts volumeInspectCommand.GlobalFlags = MainGlobalOpts
return volumeInspectCmd(&volumeInspectCommand) return volumeInspectCmd(&volumeInspectCommand)
}, },
Example: "[VOLUME-NAME ...]", Example: `podman volume inspect myvol
podman volume inspect --all
podman volume inspect --format "{{.Driver}} {{.Scope}}" myvol`,
} }
) )

View File

@ -4,7 +4,7 @@
podman\-exec - Execute a command in a running container podman\-exec - Execute a command in a running container
## SYNOPSIS ## SYNOPSIS
**podman exec** *container* [*options*] [*command* [*arg* ...]] **podman exec** [*options*] *container* [*command* [*arg* ...]]
## DESCRIPTION ## DESCRIPTION
**podman exec** executes a command in a running container. **podman exec** executes a command in a running container.
@ -46,6 +46,12 @@ The default working directory for running binaries within a container is the roo
The image developer can set a different default with the WORKDIR instruction, which can be overridden The image developer can set a different default with the WORKDIR instruction, which can be overridden
when creating the container. when creating the container.
## EXAMPLES
$ podman exec -it ctrID ls
$ podman exec -it -w /tmp myCtr pwd
$ podman exec --user root ctrID ls
## SEE ALSO ## SEE ALSO
podman(1), podman-run(1) podman(1), podman-run(1)