Make the kpod manpages a bit more uniform
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
This commit is contained in:
TomSweeneyRedHat
parent
79c5160e5a
commit
b0fac5596c
9 changed files with 32 additions and 26 deletions
|
|
@ -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
|
||||
% JULY 2017
|
||||
# NAME
|
||||
kpod-history - Shows the history of an image.
|
||||
% kpod-history "1" "JULY 2017" "kpod"
|
||||
|
||||
# SYNOPSIS
|
||||
## NAME
|
||||
kpod-history - Shows the history of an image
|
||||
|
||||
## SYNOPSIS
|
||||
**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]**
|
||||
|
||||
# DESCRIPTION
|
||||
## DESCRIPTION
|
||||
**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
|
||||
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]**
|
||||
|
||||
# GLOBAL OPTIONS
|
||||
## GLOBAL OPTIONS
|
||||
|
||||
**--help, -h**
|
||||
Print usage statement
|
||||
|
||||
# OPTIONS
|
||||
## OPTIONS
|
||||
|
||||
**--human, -H**
|
||||
Display sizes and dates in human readable format
|
||||
|
|
@ -51,7 +52,7 @@ Valid placeholders for the Go template are listed below:
|
|||
**--json**
|
||||
Print the history in JSON form
|
||||
|
||||
# COMMANDS
|
||||
## COMMANDS
|
||||
|
||||
**kpod history debian**
|
||||
|
||||
|
|
@ -62,8 +63,8 @@ Valid placeholders for the Go template are listed below:
|
|||
## history
|
||||
Show the history of an image
|
||||
|
||||
# SEE ALSO
|
||||
## SEE ALSO
|
||||
kpod(1), crio(8), crio.conf(5)
|
||||
|
||||
# HISTORY
|
||||
## HISTORY
|
||||
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
% kpod(1) kpod-images - List images in local storage.
|
||||
% kpod(1) kpod-images - List images in local storage
|
||||
% Dan Walsh
|
||||
# kpod-images "1" "March 2017" "kpod"
|
||||
|
||||
## NAME
|
||||
kpod images - List images in local storage.
|
||||
kpod images - List images in local storage
|
||||
|
||||
## SYNOPSIS
|
||||
**kpod** **images** [*options* [...]]
|
||||
|
|
|
|||
|
|
@ -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
|
||||
% JULY 2017
|
||||
% kpod-version "1" "JULY 2017" "kpod"
|
||||
|
||||
# NAME
|
||||
## NAME
|
||||
kpod-info - Display System Information
|
||||
|
||||
|
||||
# SYNOPSIS
|
||||
## SYNOPSIS
|
||||
**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.
|
||||
|
||||
|
|
@ -32,5 +32,5 @@ Show additional information
|
|||
|
||||
`kpod info --debug --json | jq .host.kernel`
|
||||
|
||||
# SEE ALSO
|
||||
## SEE ALSO
|
||||
crio(8), crio.conf(5)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
kpod inspect - display a container or image's configuration
|
||||
kpod inspect - Display a container or image's configuration
|
||||
|
||||
## SYNOPSIS
|
||||
**kpod** **inspect** [*options* [...]] name
|
||||
|
|
|
|||
|
|
@ -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
|
||||
kpod push - Push an image from local storage to elsewhere.
|
||||
kpod push - Push an image from local storage to elsewhere
|
||||
|
||||
## SYNOPSIS
|
||||
**kpod** **push** [*options* [...]] **imageID** [**destination**]
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
# kpod-rmi "1" "March 2017" "kpod"
|
||||
|
||||
## NAME
|
||||
kpod rmi - Removes one or more images.
|
||||
kpod rmi - Removes one or more images
|
||||
|
||||
## SYNOPSIS
|
||||
**kpod** **rmi** **imageID [...]**
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
# kpod-save "1" "July 2017" "kpod"
|
||||
|
||||
## NAME
|
||||
kpod-save - save an image to docker-archive or oci
|
||||
kpod-save - Save an image to docker-archive or oci
|
||||
|
||||
## SYNOPSIS
|
||||
**kpod save**
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
% kpod(1) kpod-tag - add tags to an image
|
||||
% kpod(1) kpod-tag - Add tags to an image
|
||||
% Ryan Cole
|
||||
# kpod-tag "1" "July 2017" "kpod"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
% kpod(1) kpod-version - Simple tool to view version information
|
||||
% Urvashi Mohnani
|
||||
# kpod-version "1" "July 2017" "kpod"
|
||||
|
||||
## NAME
|
||||
kpod-version - Display the KPOD Version Information
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue