diff options
| author | Miloslav Trmač <mitr@redhat.com> | 2021-12-02 22:28:30 +0100 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2021-12-06 15:50:53 -0500 |
| commit | 06572041619db7a9e59403c352ea64cab2617f91 (patch) | |
| tree | 195db9926177de60db9bc89768baa9cafe90b854 /docs | |
| parent | 7dbe5508bb60ce530efd41fdfb0967f6c436a3b7 (diff) | |
| download | podman-06572041619db7a9e59403c352ea64cab2617f91.tar.gz podman-06572041619db7a9e59403c352ea64cab2617f91.tar.bz2 podman-06572041619db7a9e59403c352ea64cab2617f91.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')
| -rw-r--r-- | docs/source/markdown/podman-save.1.md | 21 |
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 1f1f60b22..f5c35747e 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**. @@ -35,17 +35,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** |