summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-08-23 14:01:20 -0400
committerGitHub <noreply@github.com>2021-08-23 14:01:20 -0400
commit90cf78b199772082025f22e4ebc0e30c133d2a88 (patch)
treee890e717d5b5ce7bc51821776607464a7759271d /docs
parent6a3741598cc30216a1a8db7d2c917e19bc37002b (diff)
parentedddfe8c4f7761b12dc64ea4aa0a83b755aa124f (diff)
downloadpodman-90cf78b199772082025f22e4ebc0e30c133d2a88.tar.gz
podman-90cf78b199772082025f22e4ebc0e30c133d2a88.tar.bz2
podman-90cf78b199772082025f22e4ebc0e30c133d2a88.zip
Merge pull request #11290 from flouthoc/volume-export
volumes: Add support for `volume export` which allows exporting content to external path.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-volume-export.1.md38
-rw-r--r--docs/source/markdown/podman-volume.1.md1
-rw-r--r--docs/source/volume.rst2
3 files changed, 41 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-volume-export.1.md b/docs/source/markdown/podman-volume-export.1.md
new file mode 100644
index 000000000..caaa37652
--- /dev/null
+++ b/docs/source/markdown/podman-volume-export.1.md
@@ -0,0 +1,38 @@
+% podman-volume-export(1)
+
+## NAME
+podman\-volume\-export - Exports volume to external tar
+
+## SYNOPSIS
+**podman volume export** [*options*] *volume*
+
+## DESCRIPTION
+
+**podman volume export** exports the contents of a podman volume and saves it as a tarball
+on the local machine. **podman volume export** writes to STDOUT by default and can be
+redirected to a file using the `--output` flag.
+
+Note: Following command is not supported by podman-remote.
+
+**podman volume export [OPTIONS] VOLUME**
+
+## OPTIONS
+
+#### **--output**, **-o**=*file*
+
+Write to a file, default is STDOUT
+
+#### **--help**
+
+Print usage statement
+
+
+## EXAMPLES
+
+```
+$ podman volume export myvol --output myvol.tar
+
+```
+
+## SEE ALSO
+podman-volume(1)
diff --git a/docs/source/markdown/podman-volume.1.md b/docs/source/markdown/podman-volume.1.md
index 5af5eb50e..20319ccf7 100644
--- a/docs/source/markdown/podman-volume.1.md
+++ b/docs/source/markdown/podman-volume.1.md
@@ -15,6 +15,7 @@ podman volume is a set of subcommands that manage volumes.
| ------- | ------------------------------------------------------ | ------------------------------------------------------------------------------ |
| create | [podman-volume-create(1)](podman-volume-create.1.md) | Create a new volume. |
| exists | [podman-volume-exists(1)](podman-volume-exists.1.md) | Check if the given volume exists. |
+| export | [podman-volume-export(1)](podman-volume-export.1.md) | Exports volume to external tar. |
| inspect | [podman-volume-inspect(1)](podman-volume-inspect.1.md) | Get detailed information on one or more volumes. |
| ls | [podman-volume-ls(1)](podman-volume-ls.1.md) | List all the available volumes. |
| prune | [podman-volume-prune(1)](podman-volume-prune.1.md) | Remove all unused volumes. |
diff --git a/docs/source/volume.rst b/docs/source/volume.rst
index ce9ea2cbd..fb607cc2b 100644
--- a/docs/source/volume.rst
+++ b/docs/source/volume.rst
@@ -4,6 +4,8 @@ Volume
:doc:`exists <markdown/podman-volume-exists.1>` Check if the given volume exists
+:doc:`export <markdown/podman-volume-export.1>` Exports volume to external tar
+
:doc:`inspect <markdown/podman-volume-inspect.1>` Display detailed information on one or more volumes
:doc:`ls <markdown/podman-volume-ls.1>` List volumes