Skip to content

Commit

Permalink
Merge pull request containers#12489 from mtrmac/save-me-from-repetition
Browse files Browse the repository at this point in the history
Improve documentation of (podman image save)
  • Loading branch information
openshift-merge-robot authored Dec 3, 2021
2 parents dd109da + 2e132d1 commit a50502d
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/source/markdown/podman-save.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand All @@ -27,29 +27,30 @@ 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*

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**
Expand Down

0 comments on commit a50502d

Please sign in to comment.