From b0fac5596cd3ad4a6361c28cd296aa190996a7a2 Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Sat, 29 Jul 2017 13:26:21 -0400 Subject: [PATCH] Make the kpod manpages a bit more uniform Signed-off-by: TomSweeneyRedHat --- docs/kpod-history.1.md | 23 ++++++++++++----------- docs/kpod-images.1.md | 4 ++-- docs/kpod-info.1.md | 12 ++++++------ docs/kpod-inspect.1.md | 6 ++++-- docs/kpod-push.1.md | 6 ++++-- docs/kpod-rmi.1.md | 2 +- docs/kpod-save.1.md | 2 +- docs/kpod-tag.1.md | 2 +- docs/kpod-version.1.md | 1 + 9 files changed, 32 insertions(+), 26 deletions(-) diff --git a/docs/kpod-history.1.md b/docs/kpod-history.1.md index 6f48debb..701c5243 100644 --- a/docs/kpod-history.1.md +++ b/docs/kpod-history.1.md @@ -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 diff --git a/docs/kpod-images.1.md b/docs/kpod-images.1.md index 8c534d1f..1bec7fc2 100644 --- a/docs/kpod-images.1.md +++ b/docs/kpod-images.1.md @@ -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* [...]] diff --git a/docs/kpod-info.1.md b/docs/kpod-info.1.md index b2cc16f4..13879c73 100644 --- a/docs/kpod-info.1.md +++ b/docs/kpod-info.1.md @@ -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) diff --git a/docs/kpod-inspect.1.md b/docs/kpod-inspect.1.md index 3d5fbccb..21d41a15 100644 --- a/docs/kpod-inspect.1.md +++ b/docs/kpod-inspect.1.md @@ -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 diff --git a/docs/kpod-push.1.md b/docs/kpod-push.1.md index 6a2fc1c3..8d396218 100644 --- a/docs/kpod-push.1.md +++ b/docs/kpod-push.1.md @@ -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**] diff --git a/docs/kpod-rmi.1.md b/docs/kpod-rmi.1.md index ab810e3c..1566f961 100644 --- a/docs/kpod-rmi.1.md +++ b/docs/kpod-rmi.1.md @@ -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 [...]** diff --git a/docs/kpod-save.1.md b/docs/kpod-save.1.md index a08e23aa..454a18f0 100644 --- a/docs/kpod-save.1.md +++ b/docs/kpod-save.1.md @@ -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** diff --git a/docs/kpod-tag.1.md b/docs/kpod-tag.1.md index d26f6aeb..b92b2eb1 100644 --- a/docs/kpod-tag.1.md +++ b/docs/kpod-tag.1.md @@ -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" diff --git a/docs/kpod-version.1.md b/docs/kpod-version.1.md index 57e6d592..60c79f77 100644 --- a/docs/kpod-version.1.md +++ b/docs/kpod-version.1.md @@ -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