From 5770dc2640c216525ab84031e3712fcc46b3b087 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Fri, 15 Dec 2017 16:58:36 -0500 Subject: Rename all references to kpod to podman The decision is in, kpod is going to be named podman. Signed-off-by: Daniel J Walsh Closes: #145 Approved by: umohnani8 --- docs/podman-history.1.md | 106 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 docs/podman-history.1.md (limited to 'docs/podman-history.1.md') diff --git a/docs/podman-history.1.md b/docs/podman-history.1.md new file mode 100644 index 000000000..f4a089b3c --- /dev/null +++ b/docs/podman-history.1.md @@ -0,0 +1,106 @@ +% podman(1) podman-history - Simple tool to view the history of an image +% Urvashi Mohnani +% podman-history "1" "JULY 2017" "podman" + +## NAME +podman-history - Shows the history of an image + +## SYNOPSIS +**podman history** +**IMAGE[:TAG|DIGEST]** +[**--human**|**-H**] +[**--no-trunc**] +[**--quiet**|**-q**] +[**--format**] +[**--help**|**-h**] + +## DESCRIPTION +**podman 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 +be truncated or not using the **--no-trunc** flag. If the **--human** flag is +set, the time of creation and size are printed out in a human readable format. +The **--quiet** flag displays the ID of the image only when set and the **--format** +flag is used to print the information using the Go template provided by the user. + +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| --------------- | ----------------------------------------------------------------------------- | +| .ID | Image ID | +| .Created | if **--human**, time elapsed since creation, otherwise time stamp of creation | +| .CreatedBy | Command used to create the layer | +| .Size | Size of layer on disk | +| .Comment | Comment for the layer | + +**podman [GLOBAL OPTIONS]** + +**podman history [GLOBAL OPTIONS]** + +**podman history [OPTIONS] IMAGE[:TAG|DIGEST]** + +## OPTIONS + +**--human, -H** + Display sizes and dates in human readable format + +**--no-trunc** + Do not truncate the output + +**--quiet, -q** + Print the numeric IDs only + +**--format** + Alter the output for a format like 'json' or a Go template. + + +## EXAMPLES + +``` +# podman 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 +``` + +``` +# podman 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 +``` + +``` +# podman history --format "{{.ID}} {{.Created}}" debian +b676ca55e4f2c 9 weeks ago + 9 weeks ago +``` + +``` +# podman 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 + +## SEE ALSO +podman(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Urvashi Mohnani -- cgit v1.2.3-54-g00ecf