summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-images.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 14:38:25 +0200
commitbc48211924bd8f88263149f8b5d047a52f8d1733 (patch)
tree9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-images.1.md
parent7e4b13b94699ee688c146afab727d2dec991376a (diff)
downloadpodman-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-images.1.md')
-rw-r--r--docs/source/markdown/podman-images.1.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md
index 23cce450a..4aac40a61 100644
--- a/docs/source/markdown/podman-images.1.md
+++ b/docs/source/markdown/podman-images.1.md
@@ -15,15 +15,15 @@ Displays locally stored images, their names, and their IDs.
## OPTIONS
-#### **--all**, **-a**
+#### **\-\-all**, **-a**
Show all images (by default filter out the intermediate image layers). The default is false.
-#### **--digests**
+#### **\-\-digests**
Show image digests
-#### **--filter**=*filter*, **-f**
+#### **\-\-filter**=*filter*, **-f**
Filter output based on conditions provided
@@ -47,7 +47,7 @@ Filter output based on conditions provided
**reference=**
Filter by image name, specified as regular expressions.
-#### **--format**=*format*
+#### **\-\-format**=*format*
Change the default output format. This can be of a supported type like 'json'
or a Go template.
@@ -64,23 +64,23 @@ Valid placeholders for the Go template are listed below:
| .Size | Size of layer on disk |
| .History | History of the image layer |
-#### **--history**
+#### **\-\-history**
Display the history of image names. If an image gets re-tagged or untagged, then the image name history gets prepended (latest image first). This is especially useful when undoing a tag operation or an image does not contain any name because it has been untagged.
-#### **--noheading**, **-n**
+#### **\-\-noheading**, **-n**
Omit the table headings from the listing of images.
-#### **--no-trunc**
+#### **\-\-no-trunc**
Do not truncate output.
-#### **--quiet**, **-q**
+#### **\-\-quiet**, **-q**
Lists only the image IDs.
-#### **--sort**=*sort*
+#### **\-\-sort**=*sort*
Sort by created, id, repository, size or tag (default: created)