summaryrefslogtreecommitdiff
path: root/docs/podman-commit.1.md
diff options
context:
space:
mode:
authorAshley Cui <ashleycui16@gmail.com>2019-05-31 15:21:47 -0400
committerAshley Cui <ashleycui16@gmail.com>2019-06-10 11:48:02 -0400
commit19e0928037e2d9c6fb0941e2ac40b8cea731e22d (patch)
tree1b5b10718e2c27c690ae789392fe1d46535a4401 /docs/podman-commit.1.md
parent7b0d6fcf0e3ce59f842273f670d742aaf597bf2f (diff)
downloadpodman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.gz
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.bz2
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.zip
standardize documentation formatting
Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'docs/podman-commit.1.md')
-rw-r--r--docs/podman-commit.1.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/podman-commit.1.md b/docs/podman-commit.1.md
index 7c74d7a33..bf0df0dda 100644
--- a/docs/podman-commit.1.md
+++ b/docs/podman-commit.1.md
@@ -7,7 +7,7 @@ podman\-commit - Create new image based on the changed container
**podman commit** [*options*] *container* *image*
## DESCRIPTION
-`podman commit` creates an image based on a changed container. The author of the
+**podman commit** creates an image based on a changed container. The author of the
image can be set using the `--author` flag. Various image instructions can be
configured with the `--change` flag and a commit message can be set using the
`--message` flag. The container and its processes are paused while the image is
@@ -19,23 +19,23 @@ If *image* does not begin with a registry name component, `localhost` will be ad
## OPTIONS
-**--author, -a**
+**--author**, **-a**=*author*
Set the author for the committed image
-**--change, -c**
+**--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**, **-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.
@@ -43,15 +43,15 @@ Write the image ID to the file.
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**, **-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