Make the README.md more useful in links to man page documentation

This patch will allow people who go to the github page to easily read
man pages.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh 2017-07-17 09:48:22 -04:00
parent db310e9641
commit d43e67ad00
9 changed files with 75 additions and 53 deletions

View file

@ -1,10 +1,10 @@
% kpod(8) # kpod - Simple management tool for pods and images
% kpod(1) kpod - Simple management tool for pods and images
% Dan Walsh
% SEPTEMBER 2016
# NAME
kpod
# kpod "1" "September 2016" "kpod"
## NAME
kpod - Simple management tool for containers and images
# SYNOPSIS
## SYNOPSIS
**kpod**
[**--help**|**-h**]
@ -19,7 +19,7 @@ has the capability to debug pods/images created by crio.
**kpod [GLOBAL OPTIONS]**
# GLOBAL OPTIONS
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
@ -27,19 +27,19 @@ has the capability to debug pods/images created by crio.
**--version, -v**
Print the version
# COMMANDS
## COMMANDS
## images
### images
List images in local storage
## rmi
### rmi
Removes one or more locally stored images
## tag
### tag
Add one or more additional names to locally-stored image
# SEE ALSO
## SEE ALSO
crio(8), crio.conf(5)
# HISTORY
## HISTORY
Dec 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com>