diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2021-12-03 14:56:46 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-03 14:56:46 +0100 |
| commit | a50502dd3d8ef5c80d686824ba2023927825fd2c (patch) | |
| tree | 9bfd97722aa44250118a0acb8b20b64cd49ee98e | |
| parent | dd109daa45bafc85487aa2e627202d23b5c76021 (diff) | |
| parent | 2e132d1d430f21fff5946ac2d97912b4b246409c (diff) | |
| download | podman-a50502dd3d8ef5c80d686824ba2023927825fd2c.tar.gz podman-a50502dd3d8ef5c80d686824ba2023927825fd2c.tar.bz2 podman-a50502dd3d8ef5c80d686824ba2023927825fd2c.zip | |
Merge pull request #12489 from mtrmac/save-me-from-repetition
Improve documentation of (podman image save)
| -rw-r--r-- | docs/source/markdown/podman-save.1.md | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/source/markdown/podman-save.1.md b/docs/source/markdown/podman-save.1.md index 3fe99e911..0de64e518 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**. @@ -27,11 +27,11 @@ Note: `:` is a restricted character and cannot be part of the file name. #### **--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 +Note: This flag can only be set with **--format=docker-dir**. #### **--uncompressed** -Accept uncompressed layers when copying OCI images. +Accept uncompressed layers when using one of the OCI formats. #### **--output**, **-o**=*file* @@ -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** |