From 3e7227789b16854886c018aedbf843d006622d6d Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Thu, 5 Oct 2017 13:38:40 -0400 Subject: [PATCH] Cleanup READMEs and Man pages Alphabatize correctly and add missing content. Also add video. Signed-off-by: Daniel J Walsh --- README.md | 4 ++-- docs/kpod.1.md | 9 ++++++--- transfer.md | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8e6c3d41..34b56727 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,12 @@ It is currently in active development in the Kubernetes community through the [d | [kpod-images(1)](/docs/kpod-images.1.md) | List images in local storage |[![...](/docs/play.png)](https://asciinema.org/a/133649)| | [kpod-info(1)](/docs/kpod-info.1.md) | Display system information || | [kpod-inspect(1)](/docs/kpod-inspect.1.md) | Display the configuration of a container or image |[![...](/docs/play.png)](https://asciinema.org/a/133418)| -| [kpod-kill(1)](/docs/kpod-kill.1.md) | Kill the main process in one or more running containers +| [kpod-kill(1)](/docs/kpod-kill.1.md) | Kill the main process in one or more running containers |[![...](/docs/play.png)](https://asciinema.org/a/3jNos0A5yzO4hChu7ddKkUPw7)| | [kpod-load(1)](/docs/kpod-load.1.md) | Load an image from docker archive or oci |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)| | [kpod-logs(1)](/docs/kpod-logs.1.md) | Display the logs of a container || | [kpod-mount(1)](/docs/kpod-mount.1.md) | Mount a working container's root filesystem || -| [kpod-ps(1)](/docs/kpod-ps.1.md) | Prints out information about containers |[![...](/docs/play.png)](https://asciinema.org/a/bbT41kac6CwZ5giESmZLIaTLR)| | [kpod-pause(1)](/docs/kpod-pause.1.md) | Pause one or more running containers || +| [kpod-ps(1)](/docs/kpod-ps.1.md) | Prints out information about containers |[![...](/docs/play.png)](https://asciinema.org/a/bbT41kac6CwZ5giESmZLIaTLR)| | [kpod-pull(1)](/docs/kpod-pull.1.md) | Pull an image from a registry |[![...](/docs/play.png)](https://asciinema.org/a/lr4zfoynHJOUNu1KaXa1dwG2X)| | [kpod-push(1)](/docs/kpod-push.1.md) | Push an image to a specified destination |[![...](/docs/play.png)](https://asciinema.org/a/133276)| | [kpod-rename(1)](/docs/kpod-rename.1.md) | Rename a container || diff --git a/docs/kpod.1.md b/docs/kpod.1.md index fa409a3b..1617b252 100644 --- a/docs/kpod.1.md +++ b/docs/kpod.1.md @@ -109,18 +109,21 @@ Display a live stream of one or more containers' resource usage statistics ### stop Stops one or more running containers. -### unpause -Unpause one or more containers - ### tag Add an additional name to a local image ### 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) diff --git a/transfer.md b/transfer.md index 752e8263..b6d23b47 100644 --- a/transfer.md +++ b/transfer.md @@ -55,8 +55,8 @@ There are other equivalents for these tools | `docker rm` | [`kpod rm`](./docs/kpod-rm.1.md) | | `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) | | `docker save` | [`kpod save`](./docs/kpod-save.1.md) | -| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) | | `docker stop` | [`kpod stop`](./docs/kpod-stop.1.md) | +| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) | | `docker unpause`| [`kpod unpause`](./docs/kpod-unpause.1.md)| | `docker version`| [`kpod version`](./docs/kpod-version.1.md)| | `docker wait` | [`kpod wait`](./docs/kpod-wait.1.md)|