From 8898621b4ebeaad2592a0aaf4706eaaebfb67d0b Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat <tsweeney@redhat.com> Date: Sat, 10 Mar 2018 11:30:51 -0500 Subject: Update commands section to a table and add missing commands Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> --- docs/podman.1.md | 138 ++++++++++++++++--------------------------------------- 1 file changed, 40 insertions(+), 98 deletions(-) diff --git a/docs/podman.1.md b/docs/podman.1.md index ad9138a1d..84f9a855a 100644 --- a/docs/podman.1.md +++ b/docs/podman.1.md @@ -52,104 +52,46 @@ has the capability to debug pods/images created by crio. ## COMMANDS -### attach -Attach to a running container - -### commit -Create new image based on the changed 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 - -### 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 +| Command | Description | +| ----------------------------------------- | ------------------------------------------------------------------------------ | +| [podman-attach(1)](podman-attach.1.md) | Attach to a running container. | +| [podman-build(1)](podman-build.1.md) | Build a container using a Dockerfile. | +| [podman-commit(1)](podman-commit.1.md) | Create new image based on the changed container. | +| [podman-cp(1)](podman-cp.1.md) | Copy files/folders between a container and the local filesystem. | +| [podman-create(1)](podman-create.1.md) | Create a new container. | +| [podman-diff(1)](podman-diff.1.md) | Inspect changes on a container or image's filesystem. | +| [podman-exec(1)](podman-exec.1.md) | Execute a command in a running container. | +| [podman-export(1)](podman-export.1.md) | Export a container's filesystem contents as a tar archive. | +| [podman-history(1)](podman-history.1.md) | Show the history of an image. | +| [podman-images(1)](podman-images.1.md) | List images in local storage. | +| [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. | +| [podman-info(1)](podman-info.1.md) | Displays Podman related system information. | +| [podman-inspect(1)](podman-inspect.1.md) | Display a container or image's configuration. | +| [podman-kill(1)](podman-kill.1.md) | Kill the main process in one or more containers. | +| [podman-load(1)](podman-load.1.md) | Load an image from the docker archive. | +| [podman-login(1)](podman-login.1.md) | Login to a container registry. | +| [podman-logout(1)](podman-logout.1.md) | Logout of a container registry. | +| [podman-logs(1)](podman-logs.1.md) | Display the logs of a container. | +| [podman-mount(1)](podman-mount.1.md) | Mount a working container's root filesystem. | +| [podman-pause(1)](podman-pause.1.md) | Pause one or more containers. | +| [podman-port(1)](podman-port.1.md) | List port mappings for the container. | +| [podman-ps(1)](podman-ps.1.md) | Prints out information about containers. | +| [podman-pull(1)](podman-pull.1.md) | Pull an image from a registry. | +| [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | +| [podman-rm(1)](podman-rm.1.md) | Remove one or more containers. | +| [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | +| [podman-run(1)](podman-run.1.md) | Run a command in a container. | +| [podman-save(1)](podman-save.1.md) | Save an image to docker-archive or oci. | +| [podman-search(1)](podman-search.1.md) | Search a registry for an image. | +| [podman-start(1)](podman-start.1.md) | Starts one or more containers. | +| [podman-stats(1)](podman-stats.1.md) | Display a live stream of one or more container's resource usage statistics. | +| [podman-stop(1)](podman-stop.1.md) | Stop one or more running containers. | +| [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. | +| [podman-top(1)](podman-top.1.md) | Display the running processes of a container. | +| [podman-umount(1)](podman-umount.1.md) | Unmount a working container's root filesystem. | +| [podman-unpause(1)](podman-unpause.1.md) | Unpause one or more containers. | +| [podman-version(1)](podman-version.1.md) | Display the Podman version information. | +| [podman-wait(1)](podman-wait.1.md) | Wait on one or more containers to stop and print their exit codes. | ## SEE ALSO crio(8), crio.conf(5) -- cgit v1.2.3-54-g00ecf