diff options
author | Daniel J Walsh <dwalsh@redhat.com> | 2017-12-15 16:58:36 -0500 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2017-12-18 16:46:05 +0000 |
commit | 5770dc2640c216525ab84031e3712fcc46b3b087 (patch) | |
tree | 8a1c5c4e4a6ce6a35a3767247623a62bfd698f77 /docs/podman.1.md | |
parent | de3468e120d489d046c08dad72ba2262e222ccb1 (diff) | |
download | podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.gz podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.bz2 podman-5770dc2640c216525ab84031e3712fcc46b3b087.zip |
Rename all references to kpod to podman
The decision is in, kpod is going to be named podman.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Closes: #145
Approved by: umohnani8
Diffstat (limited to 'docs/podman.1.md')
-rw-r--r-- | docs/podman.1.md | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/docs/podman.1.md b/docs/podman.1.md new file mode 100644 index 000000000..be35c506d --- /dev/null +++ b/docs/podman.1.md @@ -0,0 +1,158 @@ +% podman(1) podman - Simple management tool for pods and images +% Dan Walsh +# podman "1" "September 2016" "podman" +## NAME +podman - Simple management tool for containers and images + +## SYNOPSIS +**podman** [*options*] COMMAND + +# DESCRIPTION +podman is a simple client only tool to help with debugging issues when daemons +such as CRI runtime and the kubelet are not responding or failing. A shared API +layer could be created to share code between the daemon and podman. podman does not +require any daemon running. podman utilizes the same underlying components that +crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate, +runc or any other OCI compatible runtime. podman shares state with crio and so +has the capability to debug pods/images created by crio. + +**podman [GLOBAL OPTIONS]** + +## GLOBAL OPTIONS + +**--help, -h** + Print usage statement + +**--config value, -c**=**"config.file"** + Path of a config file detailing container server configuration options + +**--cpu-profile** + Path to where the cpu performance results should be written + +**--log-level** + log messages above specified level: debug, info, warn, error (default), fatal or panic + +**--root**=**value** + Path to the root directory in which data, including images, is stored + +**--runroot**=**value** + Path to the 'run directory' where all state information is stored + +**--runtime**=**value** + Path to the OCI compatible binary used to run containers + +**--storage-driver, -s**=**value** + Select which storage driver is used to manage storage of images and containers (default is overlay) + +**--storage-opt**=**value** + Used to pass an option to the storage driver + +**--version, -v** + Print the version + +## COMMANDS + +### attach +Attach to a running container + +### create +create a new container + +### diff +Inspect changes on a container or image's filesystem + +## exec +Execute a command in a running container. + +### export +Export container's filesystem contents as a tar archive + +### history +Shows the history of an image + +### images +List images in local storage + +### info +Displays system information + +### inspect +Display a container or image's configuration + +### kill +Kill the main process in one or more containers + +### load +Load an image from docker archive + +### login +Login to a container registry + +### logout +Logout of a container registry + +### logs +Display the logs of a container + +### mount +Mount a working container's root filesystem + +### pause +Pause one or more containers + +### ps +Prints out information about containers + +### pull +Pull an image from a registry + +### push +Push an image from local storage to elsewhere + +### rename +Rename a container + +### rm +Remove one or more containers + +### rmi +Removes one or more locally stored images + +### run +Run a command in a new container + +### save +Save an image to docker-archive or oci + +## start +Starts one or more containers + +### stats +Display a live stream of one or more containers' resource usage statistics + +### stop +Stops one or more running containers. + +### tag +Add an additional name to a local image + +### top +Display the running processes of a container + +### umount +Unmount a working container's root file system + +### unpause +Unpause one or more containers + +### version +Display the version information + +### wait +Wait on one or more containers to stop and print their exit codes + +## SEE ALSO +crio(8), crio.conf(5) + +## HISTORY +Dec 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com> |