From f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Fri, 29 Jun 2018 10:53:33 -0700 Subject: docs: Follow man-pages(7) suggestions for SYNOPSIS man-pages(7) has [1]: > For commands, this shows the syntax of the command and its arguments > (including options); boldface is used for as-is text and italics are > used to indicate replaceable arguments. Brackets ([]) surround > optional arguments, vertical bars (|) separate choices, and ellipses > (...) can be repeated. I've adjusted our SYNOPSIS entries to match that formatting, and generally tried to make them more consistent with the precedent set by the man-pages project. Outside of the SYNOPSIS entry, I prefer using backticks for literals, although in some places I've left the ** bolding to keep things visually similar to a nearby SYNOPSIS entry. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King Closes: #1027 Approved by: rhatdan --- docs/podman-history.1.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) (limited to 'docs/podman-history.1.md') diff --git a/docs/podman-history.1.md b/docs/podman-history.1.md index 838994677..5b911a67f 100644 --- a/docs/podman-history.1.md +++ b/docs/podman-history.1.md @@ -4,13 +4,7 @@ podman\-history - Shows the history of an image ## SYNOPSIS -**podman history** -**IMAGE[:TAG|DIGEST]** -[**--human**|**-H**] -[**--no-trunc**] -[**--quiet**|**-q**] -[**--format**] -[**--help**|**-h**] +**podman history** [*options*] *image*[:*tag*|@*digest*] ## DESCRIPTION **podman history** displays the history of an image by printing out information @@ -31,12 +25,6 @@ Valid placeholders for the Go template are listed below: | .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** @@ -55,6 +43,9 @@ Print the numeric IDs only Alter the output for a format like 'json' or a Go template. +**--help**, **-h** + +Print usage statement ## EXAMPLES -- cgit v1.2.3-54-g00ecf