opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-21 17:16:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation of (podman image save --format)

Browse Source 
- 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>
This commit is contained in:
Miloslav Trmač
2021-12-02 22:28:30 +01:00
parent 87de344eeb
commit 952046ffdd
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/markdown/podman-save.1.md
View File

@ -9,8 +9,8 @@ podman\-save - Save image(s) to an archive
**podman image save** [*options*] *name*[:*tag*] **podman image save** [*options*] *name*[:*tag*]
## DESCRIPTION ## 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, **podman save** saves an image to a local file or directory.
default is **docker-archive**. **podman save** writes to STDOUT by default and can be redirected to a **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. 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**. **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**. To export the containers, use the **podman export**.
@ -39,17 +39,18 @@ Write to a file, default is STDOUT
#### **--format**=*format* #### **--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). An image format to produce, one of:
```
--format docker-archive | Format | Description |
--format oci-archive | ------------------ | ---------------------------------------------------------------------------- |
--format oci-dir | **docker-archive** | A tar archive interoperable with **docker load(1)** (the default) |
--format docker-dir | **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** #### **--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. The default for this option can be modified via the `multi_image_archive="true"|"false"` flag in containers.conf.
#### **--quiet**, **-q** #### **--quiet**, **-q**