From 5a1314547a87242dc48672403c0c63dd1cebe8ac Mon Sep 17 00:00:00 2001 From: umohnani8 Date: Thu, 28 Sep 2017 11:42:25 -0400 Subject: [PATCH] Made some changes to man pages kpod ps manpage had misleading info Fixed the Global options and options in other man pages Signed-off-by: umohnani8 --- docs/kpod-export.1.md | 8 ++---- docs/kpod-history.1.md | 57 ++++++++++++++++++++++++++++++++++-------- docs/kpod-load.1.md | 9 +++---- docs/kpod-ps.1.md | 16 ++++++------ docs/kpod-pull.1.md | 7 +----- docs/kpod-save.1.md | 10 +++----- docs/kpod-version.1.md | 7 +----- 7 files changed, 66 insertions(+), 48 deletions(-) diff --git a/docs/kpod-export.1.md b/docs/kpod-export.1.md index 260cac6b..c344f136 100644 --- a/docs/kpod-export.1.md +++ b/docs/kpod-export.1.md @@ -8,6 +8,7 @@ kpod-export - Export container's filesystem contents as a tar archive ## SYNOPSIS **kpod export** **CONTAINER** +[**--output**|**-o**] [**--help**|**-h**] ## DESCRIPTION @@ -19,18 +20,13 @@ redirected to a file using the **output flag**. **kpod export [GLOBAL OPTIONS]** -**kpod export [OPTIONS] CONTAINER [GLOBAL OPTIONS]** +**kpod export [OPTIONS] CONTAINER** ## OPTIONS **--output, -o** Write to a file, default is STDOUT -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement - ## EXAMPLES ``` diff --git a/docs/kpod-history.1.md b/docs/kpod-history.1.md index 713da6f5..ae75e376 100644 --- a/docs/kpod-history.1.md +++ b/docs/kpod-history.1.md @@ -6,7 +6,13 @@ kpod-history - Shows the history of an image ## SYNOPSIS -**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]** +**kpod history** +**IMAGE[:TAG|DIGEST]** +[**--human**|**-H**] +[**--no-trunc**] +[**--quiet**|**-q**] +[**--format**] +[**--help**|**-h**] ## DESCRIPTION **kpod history** displays the history of an image by printing out information @@ -29,12 +35,9 @@ Valid placeholders for the Go template are listed below: **kpod [GLOBAL OPTIONS]** -**kpod [GLOBAL OPTIONS] history [OPTIONS]** +**kpod history [GLOBAL OPTIONS]** -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement +**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]** ## OPTIONS @@ -51,15 +54,47 @@ Valid placeholders for the Go template are listed below: Alter the output for a format like 'json' or a Go template. -## COMMANDS +## EXAMPLES -**kpod history debian** +``` +# kpod history debian +ID CREATED CREATED BY SIZE COMMENT +b676ca55e4f2c 9 weeks ago /bin/sh -c #(nop) CMD ["bash"] 0 B + 9 weeks ago /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45.14 MB +``` -**kpod history --no-trunc=true --human=false debian** +``` +# kpod history --no-trunc=true --human=false debian +ID CREATED CREATED BY SIZE COMMENT +b676ca55e4f2c 2017-07-24T16:52:55Z /bin/sh -c #(nop) CMD ["bash"] 0 + 2017-07-24T16:52:54Z /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45142935 +``` -**kpod history --format "{{.ID}} {{.Created}}" debian** +``` +# kpod history --format "{{.ID}} {{.Created}}" debian +b676ca55e4f2c 9 weeks ago + 9 weeks ago +``` -**kpod history --format json debian** +``` +# kpod history --format json debian +[ + { + "id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060", + "created": "2017-07-24T16:52:55.195062314Z", + "createdBy": "/bin/sh -c #(nop) CMD [\"bash\"]", + "size": 0, + "comment": "" + }, + { + "id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060", + "created": "2017-07-24T16:52:54.898893387Z", + "createdBy": "/bin/sh -c #(nop) ADD file:ebba725fb97cea45d0b1b35ccc8144e766fcfc9a78530465c23b0c4674b14042 in / ", + "size": 45142935, + "comment": "" + } +] +``` ## history Show the history of an image diff --git a/docs/kpod-load.1.md b/docs/kpod-load.1.md index e1a3257e..34711c9f 100644 --- a/docs/kpod-load.1.md +++ b/docs/kpod-load.1.md @@ -8,6 +8,8 @@ kpod-load - Load an image from docker archive ## SYNOPSIS **kpod load** **NAME[:TAG|@DIGEST]** +[**--input**|**-i**] +[**--quiet**|**-q**] [**--help**|**-h**] ## DESCRIPTION @@ -19,7 +21,7 @@ The **quiet** flag suppresses the output when set. **kpod load [GLOBAL OPTIONS]** -**kpod load [OPTIONS] NAME[:TAG|@DIGEST] [GLOBAL OPTIONS]** +**kpod load [OPTIONS] NAME[:TAG|@DIGEST]** ## OPTIONS @@ -29,11 +31,6 @@ Read from archive file, default is STDIN **--quiet, -q** Suppress the output -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement - ## EXAMPLES ``` diff --git a/docs/kpod-ps.1.md b/docs/kpod-ps.1.md index 08e65a4d..e4285531 100644 --- a/docs/kpod-ps.1.md +++ b/docs/kpod-ps.1.md @@ -6,7 +6,12 @@ kpod-ps - Prints out information about containers ## SYNOPSIS -**kpod ps [OPTIONS] CONTAINER** +**kpod ps** +[**--all**|**-a**] +[**--no-trunc**] +[**--quiet**|**-q**] +[**--fromat**] +[**--help**|**-h**] ## DESCRIPTION **kpod ps** lists the running containers on the system. Use the **--all** flag to view @@ -22,12 +27,9 @@ all the containers information. By default it lists: **kpod [GLOBAL OPTIONS]** -**kpod [GLOBAL OPTIONS] ps [OPTIONS]** +**kpod ps [GLOBAL OPTIONS]** -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement +**kpod ps [OPTIONS]** ## OPTIONS @@ -89,7 +91,7 @@ Valid filters are listed below: | since | [ID] or [Name] Containers created since this container | | volume | [VolumeName] or [MountpointDestination] Volume mounted in container | -## COMMANDS +## EXAMPLES ``` sudo kpod ps -a diff --git a/docs/kpod-pull.1.md b/docs/kpod-pull.1.md index 1787e209..647f6f89 100644 --- a/docs/kpod-pull.1.md +++ b/docs/kpod-pull.1.md @@ -50,12 +50,7 @@ Image stored in local container/storage **kpod pull [GLOBAL OPTIONS]** -**kpod pull NAME[:TAG|@DIGEST] [GLOBAL OPTIONS]** - -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement +**kpod pull NAME[:TAG|@DIGEST]** ## SEE ALSO kpod(1), crio(8), crio.conf(5) diff --git a/docs/kpod-save.1.md b/docs/kpod-save.1.md index 4d4fb12f..dbcf96d0 100644 --- a/docs/kpod-save.1.md +++ b/docs/kpod-save.1.md @@ -8,6 +8,9 @@ kpod-save - Save an image to docker-archive or oci-archive ## SYNOPSIS **kpod save** **NAME[:TAG]** +[**--quiet**|**-q**] +[**--format**] +[**--output**|**-o**] [**--help**|**-h**] ## DESCRIPTION @@ -20,7 +23,7 @@ The **quiet** flag suppresses the output when set. **kpod save [GLOBAL OPTIONS]** -**kpod save [OPTIONS] NAME[:TAG] [GLOBAL OPTIONS]** +**kpod save [OPTIONS] NAME[:TAG]** ## OPTIONS @@ -36,11 +39,6 @@ Save image to **oci-archive** **--quiet, -q** Suppress the output -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement - ## EXAMPLES ``` diff --git a/docs/kpod-version.1.md b/docs/kpod-version.1.md index 60c79f77..cdc2c925 100644 --- a/docs/kpod-version.1.md +++ b/docs/kpod-version.1.md @@ -15,12 +15,7 @@ OS, and Architecture. **kpod [GLOBAL OPTIONS]** -**kpod [GLOBAL OPTIONS] version [OPTIONS]** - -## GLOBAL OPTIONS - -**--help, -h** - Print usage statement +**kpod version** ## SEE ALSO kpod(1), crio(8), crio.conf(5)