summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-volume-rm.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-volume-rm.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-volume-rm.1.md')
-rw-r--r--docs/source/man/podman-volume-rm.1.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/man/podman-volume-rm.1.md b/docs/source/man/podman-volume-rm.1.md
new file mode 100644
index 000000000..9a2fe8c99
--- /dev/null
+++ b/docs/source/man/podman-volume-rm.1.md
@@ -0,0 +1,46 @@
+% podman-volume-rm(1)
+
+## NAME
+podman\-volume\-rm - Remove one or more volumes
+
+## SYNOPSIS
+**podman volume rm** [*options*] *volume* [...]
+
+## DESCRIPTION
+
+Removes one or more volumes. Only volumes that are not being used will be removed.
+If a volume is being used by a container, an error will be returned unless the **--force**
+flag is being used. To remove all volumes, use the **--all** flag.
+Volumes can be removed individually by providing their full name or a unique partial name.
+
+## OPTIONS
+
+**-a**, **--all**
+
+Remove all volumes.
+
+**-f**, **--force**
+
+Remove a volume by force.
+If it is being used by containers, the containers will be removed first.
+
+**--help**
+
+Print usage statement
+
+
+## EXAMPLES
+
+```
+$ podman volume rm myvol1 myvol2
+
+$ podman volume rm --all
+
+$ podman volume rm --force myvol
+```
+
+## SEE ALSO
+podman-volume(1)
+
+## HISTORY
+November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>