diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 13:52:59 +0200 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2021-03-29 13:53:50 -0400 |
| commit | ac4bdd265308f549c4db775c1674077a6c669b30 (patch) | |
| tree | a95f579c2d855ea2e4797fe04ee55aa20ec03372 /docs/source/markdown/podman-commit.1.md | |
| parent | 96ffce2198785c9d5717e3104f0afd8a0c38b6af (diff) | |
| download | podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.gz podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.bz2 podman-ac4bdd265308f549c4db775c1674077a6c669b30.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>
<MH: Fixed cherry-pick conflicts>
Signed-off-by: Matthew Heon <mheon@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-commit.1.md')
| -rw-r--r-- | docs/source/markdown/podman-commit.1.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/source/markdown/podman-commit.1.md b/docs/source/markdown/podman-commit.1.md index 7485e9bd9..35ee1d010 100644 --- a/docs/source/markdown/podman-commit.1.md +++ b/docs/source/markdown/podman-commit.1.md @@ -22,39 +22,39 @@ If *image* is not provided, the values for the `REPOSITORY` and `TAG` values of ## OPTIONS -#### **--author**, **-a**=*author* +#### **\-\-author**, **-a**=*author* Set the author for the committed image -#### **--change**, **-c**=*instruction* +#### **\-\-change**, **-c**=*instruction* Apply the following possible instructions to the created image: **CMD** | **ENTRYPOINT** | **ENV** | **EXPOSE** | **LABEL** | **ONBUILD** | **STOPSIGNAL** | **USER** | **VOLUME** | **WORKDIR** Can be set multiple times -#### **--format**, **-f**=*format* +#### **\-\-format**, **-f**=*format* Set the format of the image manifest and metadata. The currently supported formats are _oci_ and _docker_. If not specifically set, the default format used is _oci_. -#### **--iidfile**=*ImageIDfile* +#### **\-\-iidfile**=*ImageIDfile* Write the image ID to the file. -#### **--include-volumes** +#### **\-\-include-volumes** Include in the committed image any volumes added to the container by the `--volume` or `--mount` options to the `podman create` and `podman run` commands. -#### **--message**, **-m**=*message* +#### **\-\-message**, **-m**=*message* Set commit message for committed image. The message field is not supported in _oci_ format. -#### **--pause**, **-p** +#### **\-\-pause**, **-p** Pause the container when creating an image -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** Suppress output |