Merge pull request #975 from rhatdan/cleanup

Cleanup READMEs and Man pages
This commit is contained in:
Daniel J Walsh 2017-10-05 14:59:19 -04:00 committed by GitHub
commit 5b2652c3e3
3 changed files with 9 additions and 6 deletions

View file

@ -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-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-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-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-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-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-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-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-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-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 || | [kpod-rename(1)](/docs/kpod-rename.1.md) | Rename a container ||

View file

@ -109,18 +109,21 @@ Display a live stream of one or more containers' resource usage statistics
### stop ### stop
Stops one or more running containers. Stops one or more running containers.
### unpause
Unpause one or more containers
### tag ### tag
Add an additional name to a local image Add an additional name to a local image
### umount ### umount
Unmount a working container's root file system Unmount a working container's root file system
### unpause
Unpause one or more containers
### version ### version
Display the version information Display the version information
### wait
Wait on one or more containers to stop and print their exit codes
## SEE ALSO ## SEE ALSO
crio(8), crio.conf(5) crio(8), crio.conf(5)

View file

@ -55,8 +55,8 @@ There are other equivalents for these tools
| `docker rm` | [`kpod rm`](./docs/kpod-rm.1.md) | | `docker rm` | [`kpod rm`](./docs/kpod-rm.1.md) |
| `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) | | `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) |
| `docker save` | [`kpod save`](./docs/kpod-save.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 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 unpause`| [`kpod unpause`](./docs/kpod-unpause.1.md)|
| `docker version`| [`kpod version`](./docs/kpod-version.1.md)| | `docker version`| [`kpod version`](./docs/kpod-version.1.md)|
| `docker wait` | [`kpod wait`](./docs/kpod-wait.1.md)| | `docker wait` | [`kpod wait`](./docs/kpod-wait.1.md)|