diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 13:52:59 +0200 |
|---|---|---|
| committer | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 14:38:25 +0200 |
| commit | bc48211924bd8f88263149f8b5d047a52f8d1733 (patch) | |
| tree | 9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-history.1.md | |
| parent | 7e4b13b94699ee688c146afab727d2dec991376a (diff) | |
| download | podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.gz podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.bz2 podman-bc48211924bd8f88263149f8b5d047a52f8d1733.zip | |
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.
This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.
Fixes containers/podman.io#373
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-history.1.md')
| -rw-r--r-- | docs/source/markdown/podman-history.1.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/source/markdown/podman-history.1.md b/docs/source/markdown/podman-history.1.md index 2dd41e9f5..cebb45054 100644 --- a/docs/source/markdown/podman-history.1.md +++ b/docs/source/markdown/podman-history.1.md @@ -12,9 +12,9 @@ podman\-history - Show the history of an image **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 +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** +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: @@ -29,26 +29,26 @@ Valid placeholders for the Go template are listed below: ## OPTIONS -#### **--human**, **-H**=*true|false* +#### **\-\-human**, **-H**=*true|false* Display sizes and dates in human readable format (default *true*). -#### **--no-trunc**=*true|false* +#### **\-\-no-trunc**=*true|false* Do not truncate the output (default *false*). -#### **--notruncate** +#### **\-\-notruncate** Do not truncate the output -#### **--quiet**, **-q**=*true|false* +#### **\-\-quiet**, **-q**=*true|false* Print the numeric IDs only (default *false*). -#### **--format**=*format* +#### **\-\-format**=*format* Alter the output for a format like 'json' or a Go template. -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement |