vbatts/cri-o
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Make the kpod manpages a bit more uniform

Browse source 
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
This commit is contained in:
TomSweeneyRedHat 2017-07-29 13:26:21 -04:00
parent 79c5160e5a
commit b0fac5596c
9 changed files with 32 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/kpod-history.1.md
View file

@ -1,13 +1,14 @@
% kpod(8) # kpod-history - Simple tool to view the history of an image % kpod(1) kpod-history - Simple tool to view the history of an image
% Urvashi Mohnani % Urvashi Mohnani
% JULY 2017 % kpod-history "1" "JULY 2017" "kpod"
# NAME
kpod-history - Shows the history of an image.
# SYNOPSIS ## NAME
kpod-history - Shows the history of an image
## SYNOPSIS
**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]** **kpod history [OPTIONS] IMAGE[:TAG|DIGEST]**
# DESCRIPTION ## DESCRIPTION
**kpod history** displays the history of an image by printing out information **kpod history** displays the history of an image by printing out information
about each layer used in the image. The information printed out for each layer about each layer used in the image. The information printed out for each layer
include Created (time and date), Created By, Size, and Comment. The output can include Created (time and date), Created By, Size, and Comment. The output can
@ -29,12 +30,12 @@ Valid placeholders for the Go template are listed below:
**kpod [GLOBAL OPTIONS] history [OPTIONS]** **kpod [GLOBAL OPTIONS] history [OPTIONS]**
# GLOBAL OPTIONS ## GLOBAL OPTIONS
**--help, -h** **--help, -h**
Print usage statement Print usage statement
# OPTIONS ## OPTIONS
**--human, -H** **--human, -H**
Display sizes and dates in human readable format Display sizes and dates in human readable format
@ -51,7 +52,7 @@ Valid placeholders for the Go template are listed below:
**--json** **--json**
Print the history in JSON form Print the history in JSON form
# COMMANDS ## COMMANDS
**kpod history debian** **kpod history debian**
@ -62,8 +63,8 @@ Valid placeholders for the Go template are listed below:
## history ## history
Show the history of an image Show the history of an image
# SEE ALSO ## SEE ALSO
kpod(1), crio(8), crio.conf(5) kpod(1), crio(8), crio.conf(5)
# HISTORY ## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

4
docs/kpod-images.1.md
View file

@ -1,9 +1,9 @@
% kpod(1) kpod-images - List images in local storage. % kpod(1) kpod-images - List images in local storage
% Dan Walsh % Dan Walsh
# kpod-images "1" "March 2017" "kpod" # kpod-images "1" "March 2017" "kpod"
## NAME ## NAME
kpod images - List images in local storage. kpod images - List images in local storage
## SYNOPSIS ## SYNOPSIS
**kpod** **images** [*options* [...]] **kpod** **images** [*options* [...]]

12
docs/kpod-info.1.md
View file

@ -1,16 +1,16 @@
% kpod(8) # kpod-version - Simple tool to view version information % kpod(1) kpod-version - Simple tool to view version information
% Vincent Batts % Vincent Batts
% JULY 2017 % kpod-version "1" "JULY 2017" "kpod"
# NAME ## NAME
kpod-info - Display System Information kpod-info - Display System Information
# SYNOPSIS ## SYNOPSIS
**kpod** **info** [*options* [...]] **kpod** **info** [*options* [...]]
# DESCRIPTION ## DESCRIPTION
Information display here pertain to the host, current storage stats, and build of kpod. Useful for the user and when reporting issues. Information display here pertain to the host, current storage stats, and build of kpod. Useful for the user and when reporting issues.
@ -32,5 +32,5 @@ Show additional information
`kpod info --debug --json | jq .host.kernel` `kpod info --debug --json | jq .host.kernel`
# SEE ALSO ## SEE ALSO
crio(8), crio.conf(5) crio(8), crio.conf(5)

6
docs/kpod-inspect.1.md
View file

@ -1,7 +1,9 @@
## kpod-inspect "1" "July 2017" "kpod" % kpod(1) kpod-inspect - Display a container or image's configuration
% Dan Walsh
# kpod-inspect "1" "July 2017" "kpod"
## NAME ## NAME
kpod inspect - display a container or image's configuration kpod inspect - Display a container or image's configuration
## SYNOPSIS ## SYNOPSIS
**kpod** **inspect** [*options* [...]] name **kpod** **inspect** [*options* [...]] name

6
docs/kpod-push.1.md
View file

@ -1,7 +1,9 @@
## kpod-push "1" "June 2017" "kpod" % kpod(1) kpod-push - Push an image from local storage to elsewhere
% Dan Walsh
# kpod-push "1" "June 2017" "kpod"
## NAME ## NAME
kpod push - Push an image from local storage to elsewhere. kpod push - Push an image from local storage to elsewhere
## SYNOPSIS ## SYNOPSIS
**kpod** **push** [*options* [...]] **imageID** [**destination**] **kpod** **push** [*options* [...]] **imageID** [**destination**]

2
docs/kpod-rmi.1.md
View file

@ -3,7 +3,7 @@
# kpod-rmi "1" "March 2017" "kpod" # kpod-rmi "1" "March 2017" "kpod"
## NAME ## NAME
kpod rmi - Removes one or more images. kpod rmi - Removes one or more images
## SYNOPSIS ## SYNOPSIS
**kpod** **rmi** **imageID [...]** **kpod** **rmi** **imageID [...]**

2
docs/kpod-save.1.md
View file

@ -3,7 +3,7 @@
# kpod-save "1" "July 2017" "kpod" # kpod-save "1" "July 2017" "kpod"
## NAME ## NAME
kpod-save - save an image to docker-archive or oci kpod-save - Save an image to docker-archive or oci
## SYNOPSIS ## SYNOPSIS
**kpod save** **kpod save**

2
docs/kpod-tag.1.md
View file

@ -1,4 +1,4 @@
% kpod(1) kpod-tag - add tags to an image % kpod(1) kpod-tag - Add tags to an image
% Ryan Cole % Ryan Cole
# kpod-tag "1" "July 2017" "kpod" # kpod-tag "1" "July 2017" "kpod"

1
docs/kpod-version.1.md
View file

@ -1,6 +1,7 @@
% kpod(1) kpod-version - Simple tool to view version information % kpod(1) kpod-version - Simple tool to view version information
% Urvashi Mohnani % Urvashi Mohnani
# kpod-version "1" "July 2017" "kpod" # kpod-version "1" "July 2017" "kpod"
## NAME ## NAME
kpod-version - Display the KPOD Version Information kpod-version - Display the KPOD Version Information