aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorMiloslav Trmač <mitr@redhat.com>2021-12-02 22:28:30 +0100
committerMiloslav Trmač <mitr@redhat.com>2021-12-02 22:28:30 +0100
commit952046ffdd8a6c62cbe3a58d6d0ea7c47fbe03e4 (patch)
treed21bf6ef74717e8b56ad1f13fcdb6d3ae207fe48 /docs/source/markdown
parent87de344eeb8113849fdf451e864251d94222420d (diff)
downloadpodman-952046ffdd8a6c62cbe3a58d6d0ea7c47fbe03e4.tar.gz
podman-952046ffdd8a6c62cbe3a58d6d0ea7c47fbe03e4.tar.bz2
podman-952046ffdd8a6c62cbe3a58d6d0ea7c47fbe03e4.zip
Improve documentation of (podman image save --format)
- Don't pointlessly repeat the names - Improve documentation of the formats - Use a table, per MANPAGE_SYNTAX.md Signed-off-by: Miloslav Trmač <mitr@redhat.com>
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/podman-save.1.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/source/markdown/podman-save.1.md b/docs/source/markdown/podman-save.1.md
index 3fe99e911..24396b4fb 100644
--- a/docs/source/markdown/podman-save.1.md
+++ b/docs/source/markdown/podman-save.1.md
@@ -9,8 +9,8 @@ podman\-save - Save image(s) to an archive
**podman image save** [*options*] *name*[:*tag*]
## DESCRIPTION
-**podman save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) on the local machine,
-default is **docker-archive**. **podman save** writes to STDOUT by default and can be redirected to a
+**podman save** saves an image to a local file or directory.
+**podman save** writes to STDOUT by default and can be redirected to a
file using the **output** flag. The **quiet** flag suppresses the output when set.
**podman save** will save parent layers of the image(s) and the image(s) can be loaded using **podman load**.
To export the containers, use the **podman export**.
@@ -39,17 +39,18 @@ Write to a file, default is STDOUT
#### **--format**=*format*
-Save image to **docker-archive**, **oci-archive** (see `containers-transports(5)`), **oci-dir** (`oci` transport), or **docker-dir** (`dir` transport with v2s2 manifest type).
-```
---format docker-archive
---format oci-archive
---format oci-dir
---format docker-dir
-```
+An image format to produce, one of:
+
+| Format | Description |
+| ------------------ | ---------------------------------------------------------------------------- |
+| **docker-archive** | A tar archive interoperable with **docker load(1)** (the default) |
+| **oci-archive** | A tar archive using the OCI Image Format |
+| **oci-dir** | A directory using the OCI Image Format |
+| **docker-dir** | **dir** transport (see **containers-transports(5)**) with v2s2 manifest type |
#### **--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**.
+Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for **--format=docker-archive**.
The default for this option can be modified via the `multi_image_archive="true"|"false"` flag in containers.conf.
#### **--quiet**, **-q**