summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-export.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-export.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-export.1.md')
-rw-r--r--docs/source/man/podman-export.1.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/source/man/podman-export.1.md b/docs/source/man/podman-export.1.md
new file mode 100644
index 000000000..4286d0e2f
--- /dev/null
+++ b/docs/source/man/podman-export.1.md
@@ -0,0 +1,45 @@
+% podman-export(1)
+
+## NAME
+podman\-export - Export a container's filesystem contents as a tar archive
+
+## SYNOPSIS
+**podman export** [*options*] *container*
+
+**podman container export** [*options*] *container*
+
+## DESCRIPTION
+**podman export** exports the filesystem of a container and saves it as a tarball
+on the local machine. **podman export** writes to STDOUT by default and can be
+redirected to a file using the `--output` flag.
+Note: `:` is a restricted character and cannot be part of the file name.
+
+**podman [GLOBAL OPTIONS]**
+
+**podman export [GLOBAL OPTIONS]**
+
+**podman export [OPTIONS] CONTAINER**
+
+## OPTIONS
+
+**--output**, **-o**
+
+Write to a file, default is STDOUT
+
+**--help**, **-h**
+
+Print usage statement
+
+## EXAMPLES
+
+```
+$ podman export -o redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
+
+$ podman export 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57 > redis-container.tar
+```
+
+## SEE ALSO
+podman(1), podman-import(1)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>