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-save.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-save.1.md')
| -rw-r--r-- | docs/source/markdown/podman-save.1.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/source/markdown/podman-save.1.md b/docs/source/markdown/podman-save.1.md index fb79cfd2a..e6f6e993b 100644 --- a/docs/source/markdown/podman-save.1.md +++ b/docs/source/markdown/podman-save.1.md @@ -24,16 +24,16 @@ Note: `:` is a restricted character and cannot be part of the file name. ## OPTIONS -#### **--compress** +#### **\-\-compress** Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type, compressed or uncompressed, as source) Note: This flag can only be set when using the **dir** transport i.e --format=oci-dir or --format-docker-dir -#### **--output**, **-o**=*file* +#### **\-\-output**, **-o**=*file* Write to a file, default is STDOUT -#### **--format**=*format* +#### **\-\-format**=*format* Save image to **oci-archive, oci-dir** (directory with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) ``` @@ -42,15 +42,15 @@ Save image to **oci-archive, oci-dir** (directory with oci manifest type), or ** --format docker-dir ``` -#### **--multi-image-archive**, **-m** +#### **\-\-multi-image-archive**, **-m** Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for **docker-archive**. -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** Suppress the output -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement |